<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>QCNSim: QcnSim/Scheduler.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">QCNSim
   </div>
   <div id="projectbrief">Simulator for Quake-Catcher Network</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d21be12960473ba5c51e5f9beea3525e.html">QcnSim</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">Scheduler.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_scheduler_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_event_chain_element_8h.html">EventChainElement.h</a>&quot;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_simulator_globals_8h.html">SimulatorGlobals.h</a>&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_entity_8h.html">Entity.h</a>&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#include &lt;list&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#include &lt;iostream&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="class_scheduler.html">   58</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_scheduler.html">Scheduler</a> {</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="comment">//std::priority_queue&lt;EventChainElement&gt; eventChain; //!&lt;The Event Chain as a min-heap ordered by eventTime.</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="class_scheduler.html#af6ecb496c89f25f9a303dfd3b720f7cd">   65</a></span>&#160;    std::list&lt;EventChainElement&gt; <a class="code" href="class_scheduler.html#af6ecb496c89f25f9a303dfd3b720f7cd">eventChain</a>; </div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="class_scheduler.html#ae80517b2251b2352732ca0740b7bbb64">   66</a></span>&#160;    <a class="code" href="class_simulator_globals.html">SimulatorGlobals</a> &amp;<a class="code" href="class_scheduler.html#ae80517b2251b2352732ca0740b7bbb64">simulatorGlobals</a>;  </div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    <a class="code" href="class_scheduler.html#a69f30fe77aaaeb4e4945e09e0960a16a">Scheduler</a>(<a class="code" href="class_simulator_globals.html">SimulatorGlobals</a> &amp;<a class="code" href="class_scheduler.html#ae80517b2251b2352732ca0740b7bbb64">simulatorGlobals</a>, <span class="keyword">const</span> <a class="code" href="class_event.html">Event</a> &amp;event);</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    <span class="keyword">explicit</span> <a class="code" href="class_scheduler.html#a69f30fe77aaaeb4e4945e09e0960a16a">Scheduler</a>(<a class="code" href="class_simulator_globals.html">SimulatorGlobals</a> &amp;<a class="code" href="class_scheduler.html#ae80517b2251b2352732ca0740b7bbb64">simulatorGlobals</a>);</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="class_scheduler.html#ae84f19f548d606f50fba69d00fe691b1">schedule</a>(<span class="keyword">const</span> <a class="code" href="class_event.html">Event</a> &amp;event);</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="class_scheduler.html#a2efbb6f69464273b3ef92953d91018c9">scheduleFront</a>(<span class="keyword">const</span> <a class="code" href="class_event.html">Event</a> &amp;event);</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    <a class="code" href="class_event.html">Event</a> <a class="code" href="class_scheduler.html#a501e5da3b8dc453b331702aa06066eb4">cause</a>();</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_scheduler.html#ac09d9f9b4147c949268fa6bc66ced974">removeEvents</a>(std::shared_ptr&lt;const Entity&gt; entity);</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    std::list&lt;EventChainElement&gt;::size_type <a class="code" href="class_scheduler.html#a49d6d8bc35ca5e24d637a45e63cdd8e3">getChainSize</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;};</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div>
<div class="ttc" id="class_scheduler_html_ae80517b2251b2352732ca0740b7bbb64"><div class="ttname"><a href="class_scheduler.html#ae80517b2251b2352732ca0740b7bbb64">Scheduler::simulatorGlobals</a></div><div class="ttdeci">SimulatorGlobals &amp; simulatorGlobals</div><div class="ttdoc">Reference to SimulatorGlobals object, to control simulation clock time and etc. </div><div class="ttdef"><b>Definition:</b> <a href="_scheduler_8h_source.html#l00066">Scheduler.h:66</a></div></div>
<div class="ttc" id="class_scheduler_html"><div class="ttname"><a href="class_scheduler.html">Scheduler</a></div><div class="ttdoc">Scheduler class. </div><div class="ttdef"><b>Definition:</b> <a href="_scheduler_8h_source.html#l00058">Scheduler.h:58</a></div></div>
<div class="ttc" id="class_event_html"><div class="ttname"><a href="class_event.html">Event</a></div><div class="ttdoc">Event class. </div><div class="ttdef"><b>Definition:</b> <a href="_event_8h_source.html#l00035">Event.h:35</a></div></div>
<div class="ttc" id="_entity_8h_html"><div class="ttname"><a href="_entity_8h.html">Entity.h</a></div></div>
<div class="ttc" id="class_scheduler_html_ac09d9f9b4147c949268fa6bc66ced974"><div class="ttname"><a href="class_scheduler.html#ac09d9f9b4147c949268fa6bc66ced974">Scheduler::removeEvents</a></div><div class="ttdeci">unsigned int removeEvents(std::shared_ptr&lt; const Entity &gt; entity)</div><div class="ttdef"><b>Definition:</b> <a href="_scheduler_8cpp_source.html#l00118">Scheduler.cpp:118</a></div></div>
<div class="ttc" id="class_scheduler_html_ae84f19f548d606f50fba69d00fe691b1"><div class="ttname"><a href="class_scheduler.html#ae84f19f548d606f50fba69d00fe691b1">Scheduler::schedule</a></div><div class="ttdeci">void schedule(const Event &amp;event)</div><div class="ttdef"><b>Definition:</b> <a href="_scheduler_8cpp_source.html#l00056">Scheduler.cpp:56</a></div></div>
<div class="ttc" id="_simulator_globals_8h_html"><div class="ttname"><a href="_simulator_globals_8h.html">SimulatorGlobals.h</a></div></div>
<div class="ttc" id="class_simulator_globals_html"><div class="ttname"><a href="class_simulator_globals.html">SimulatorGlobals</a></div><div class="ttdoc">Simulator-scope variables and parameters. </div><div class="ttdef"><b>Definition:</b> <a href="_simulator_globals_8h_source.html#l00044">SimulatorGlobals.h:44</a></div></div>
<div class="ttc" id="_event_chain_element_8h_html"><div class="ttname"><a href="_event_chain_element_8h.html">EventChainElement.h</a></div></div>
<div class="ttc" id="class_scheduler_html_af6ecb496c89f25f9a303dfd3b720f7cd"><div class="ttname"><a href="class_scheduler.html#af6ecb496c89f25f9a303dfd3b720f7cd">Scheduler::eventChain</a></div><div class="ttdeci">std::list&lt; EventChainElement &gt; eventChain</div><div class="ttdoc">The Event Chain as a min-heap ordered by eventTime. Underlying container is a list, and this class should maintain heap order. </div><div class="ttdef"><b>Definition:</b> <a href="_scheduler_8h_source.html#l00065">Scheduler.h:65</a></div></div>
<div class="ttc" id="class_scheduler_html_a49d6d8bc35ca5e24d637a45e63cdd8e3"><div class="ttname"><a href="class_scheduler.html#a49d6d8bc35ca5e24d637a45e63cdd8e3">Scheduler::getChainSize</a></div><div class="ttdeci">std::list&lt; EventChainElement &gt;::size_type getChainSize() const </div><div class="ttdef"><b>Definition:</b> <a href="_scheduler_8cpp_source.html#l00153">Scheduler.cpp:153</a></div></div>
<div class="ttc" id="class_scheduler_html_a69f30fe77aaaeb4e4945e09e0960a16a"><div class="ttname"><a href="class_scheduler.html#a69f30fe77aaaeb4e4945e09e0960a16a">Scheduler::Scheduler</a></div><div class="ttdeci">Scheduler(SimulatorGlobals &amp;simulatorGlobals, const Event &amp;event)</div><div class="ttdoc">Constructor with initial event. </div><div class="ttdef"><b>Definition:</b> <a href="_scheduler_8cpp_source.html#l00031">Scheduler.cpp:31</a></div></div>
<div class="ttc" id="class_scheduler_html_a2efbb6f69464273b3ef92953d91018c9"><div class="ttname"><a href="class_scheduler.html#a2efbb6f69464273b3ef92953d91018c9">Scheduler::scheduleFront</a></div><div class="ttdeci">void scheduleFront(const Event &amp;event)</div><div class="ttdef"><b>Definition:</b> <a href="_scheduler_8cpp_source.html#l00083">Scheduler.cpp:83</a></div></div>
<div class="ttc" id="class_scheduler_html_a501e5da3b8dc453b331702aa06066eb4"><div class="ttname"><a href="class_scheduler.html#a501e5da3b8dc453b331702aa06066eb4">Scheduler::cause</a></div><div class="ttdeci">Event cause()</div><div class="ttdef"><b>Definition:</b> <a href="_scheduler_8cpp_source.html#l00095">Scheduler.cpp:95</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Nov 14 2013 11:18:20 for QCNSim by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
